home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / man / cat3 / XmLabel.z / XmLabel
Encoding:
Text File  |  2003-11-18  |  30.5 KB  |  661 lines

  1.  
  2.  
  3.  
  4.      XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       _X_m_L_a_b_e_l - The    Label widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.       #include <Xm/Label.h>
  13.  
  14.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.       Label    is an instantiable widget and is also used as a
  16.       superclass for other button widgets, such as PushButton and
  17.       ToggleButton.     The Label widget does not accept any button
  18.       or key input,    and the    help callback is the only callback
  19.       defined.  Label also receives    enter and leave    events.
  20.  
  21.       Label    can contain either text    or a pixmap.  Label text is a
  22.       compound string.  Refer to the OOOOSSSSFFFF////MMMMoooottttiiiiffff PPPPrrrrooooggggrrrraaaammmmmmmmeeeerrrr''''ssss    GGGGuuuuiiiiddddeeee
  23.       for more information on compound strings.  The text can be
  24.       multilingual,    multiline, and/or multifont.  When a Label is
  25.       insensitive, its text    is stippled, or    the user-supplied
  26.       insensitive pixmap is    displayed.
  27.  
  28.       Label    supports both accelerators and mnemonics primarily for
  29.       use in Label subclass    widgets    that are contained in menus.
  30.       Mnemonics are    available in a menu system when    the button is
  31.       visible.  Accelerators in a menu system are accessible even
  32.       when the button is not visible.  The Label widget displays
  33.       the mnemonic by underlining the first    matching character in
  34.       the text string.  The    accelerator is displayed as a text
  35.       string adjacent to the label text or pixmap.
  36.  
  37.       Label    consists of many margin    fields surrounding the text or
  38.       pixmap.  These margin    fields are resources that may be set
  39.       by the user, but Label subclasses and    Manager    parents    also
  40.       modify some of these fields.    They tend to modify the
  41.       _X_m_N_m_a_r_g_i_n_L_e_f_t, _X_m_N_m_a_r_g_i_n_R_i_g_h_t, _X_m_N_m_a_r_g_i_n_T_o_p, and
  42.       _X_m_N_m_a_r_g_i_n_B_o_t_t_o_m resources and    leave the _X_m_N_m_a_r_g_i_n_W_i_d_t_h and
  43.       _X_m_N_m_a_r_g_i_n_H_e_i_g_h_t resources as set by the application.
  44.  
  45.       Label    takes into account _X_m_N_s_h_a_d_o_w_T_h_i_c_k_n_e_s_s in determining
  46.       its layout but does not draw the shadow.  That is, if
  47.       _X_m_N_s_h_a_d_o_w_T_h_i_c_k_n_e_s_s is    greater    than 0,    Label leaves space for
  48.       the shadow, but the shadow does not appear.
  49.  
  50.       In a Label _X_m_N_t_r_a_v_e_r_s_a_l_O_n and    _X_m_N_h_i_g_h_l_i_g_h_t_O_n_E_n_t_e_r are    forced
  51.       to False inside Popup    MenuPanes, Pulldown MenuPanes, and
  52.       OptionMenus.    Otherwise these    resources default to False.
  53.  
  54.     CCCCllllaaaasssssssseeeessss
  55.       Label    inherits behavior and resources    from _C_o_r_e and
  56.       _X_m_P_r_i_m_i_t_i_v_e Classes.
  57.  
  58.       The class pointer is _x_m_L_a_b_e_l_W_i_d_g_e_t_C_l_a_s_s.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 11/11/03)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))
  71.  
  72.  
  73.  
  74.       The class name is _X_m_L_a_b_e_l.
  75.  
  76.     NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  77.       The following    table defines a    set of widget resources    used
  78.       by the programmer to specify data.  The programmer can also
  79.       set the resource values for the inherited classes to set
  80.       attributes for this widget.  To reference a resource by name
  81.       or by    class in a .Xdefaults file, remove the _X_m_N or _X_m_C
  82.       prefix and use the remaining letters.     To specify one    of the
  83.       defined values for a resource    in a .Xdefaults    file, remove
  84.       the _X_m prefix    and use    the remaining letters (in either
  85.       lowercase or uppercase, but include any underscores between
  86.       words).  The codes in    the access column indicate if the
  87.       given    resource can be    set at creation    time (C), set by using
  88.       _X_t_S_e_t_V_a_l_u_e_s (S), retrieved by    using _X_t_G_e_t_V_a_l_u_e_s (G), or is
  89.       not applicable (N/A).
  90.  
  91.                         XXXXmmmmLLLLaaaabbbbeeeellll    RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  92.      NNNNaaaammmmeeee             CCCCllllaaaassssssss                 TTTTyyyyppppeeee         DDDDeeeeffffaaaauuuulllltttt          AAAAcccccccceeeessssssss
  93.      ___________________________________________________________________________________________________________
  94.      XmNaccelerator         XmCAccelerator             String         NULL              CSG
  95.      XmNacceleratorText         XmCAcceleratorText         XmString         NULL              CSG
  96.      XmNalignment         XmCAlignment             unsigned char     dynamic          CSG
  97.      XmNfontList         XmCFontList             XmFontList         dynamic          CSG
  98.      XmNlabelInsensitivePixmap     XmCLabelInsensitivePixmap   Pixmap         XmUNSPECIFIED_PIXMAP      CSG
  99.      XmNlabelPixmap         XmCLabelPixmap             Pixmap         XmUNSPECIFIED_PIXMAP      CSG
  100.      XmNlabelString         XmCXmString             XmString         dynamic          CSG
  101.      XmNlabelType         XmCLabelType             unsigned char     XmSTRING          CSG
  102.      XmNmarginBottom         XmCMarginBottom         Dimension         0              CSG
  103.      XmNmarginHeight         XmCMarginHeight         Dimension         2              CSG
  104.      XmNmarginLeft         XmCMarginLeft             Dimension         0              CSG
  105.      XmNmarginRight         XmCMarginRight             Dimension         0              CSG
  106.      XmNmarginTop         XmCMarginTop             Dimension         0              CSG
  107.      XmNmarginWidth         XmCMarginWidth             Dimension         2              CSG
  108.      XmNmnemonic         XmCMnemonic             KeySym         NULL              CSG
  109.      XmNmnemonicCharSet         XmCMnemonicCharSet         String         XmFONTLIST_DEFAULT_TAG      CSG
  110.      XmNrecomputeSize         XmCRecomputeSize         Boolean         True              CSG
  111.      XmNstringDirection         XmCStringDirection         XmStringDirection     dynamic          CSG
  112.  
  113.  
  114.       _X_m_N_a_c_c_e_l_e_r_a_t_o_r
  115.            Sets the    accelerator on a button    widget in a menu,
  116.            which activates a visible or invisible, but managed,
  117.            button from the keyboard.  This resource    is a string
  118.            that describes a    set of modifiers and the key that may
  119.            be used to select the button.  The format of this
  120.            string is identical to that used    by the translations
  121.            manager,    with the exception that    only a single event
  122.            may be specified    and only _K_e_y_P_r_e_s_s events are allowed.
  123.  
  124.       Accelerators for buttons are supported only for PushButtons
  125.       and ToggleButtons in Pulldown    and Popup MenuPanes.
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 11/11/03)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))
  137.  
  138.  
  139.  
  140.       _X_m_N_a_c_c_e_l_e_r_a_t_o_r_T_e_x_t
  141.            Specifies the text displayed for    the accelerator.  The
  142.            text is displayed adjacent to the label string or
  143.            pixmap.    Accelerator text for buttons is    displayed only
  144.            for PushButtons and ToggleButtons in Pulldown and Popup
  145.            Menus.
  146.  
  147.       _X_m_N_a_l_i_g_n_m_e_n_t
  148.            Specifies the label alignment for text or pixmap.
  149.  
  150.       +o    _X_m_A_L_I_G_N_M_E_N_T__B_E_G_I_N_N_I_N_G (left alignment) -    causes the
  151.            left sides of the lines of text to be vertically
  152.            aligned with the    left edge of the widget    window.     For a
  153.            pixmap, its left    side is    vertically aligned with    the
  154.            left edge of the    widget window.
  155.  
  156.       +o    _X_m_A_L_I_G_N_M_E_N_T__C_E_N_T_E_R (center alignment) - causes the
  157.            centers of the lines of text to be vertically aligned
  158.            in the center of    the widget window.  For    a pixmap, its
  159.            center is vertically aligned with the center of the
  160.            widget window.
  161.  
  162.       +o    _X_m_A_L_I_G_N_M_E_N_T__E_N_D (right alignment) - causes the right
  163.            sides of    the lines of text to be    vertically aligned
  164.            with the    right edge of the widget window.  For a
  165.            pixmap, its right side is vertically aligned with the
  166.            right edge of the widget    window.
  167.  
  168.       The above descriptions for text are correct when
  169.       _X_m_N_s_t_r_i_n_g_D_i_r_e_c_t_i_o_n is    _X_m_S_T_R_I_N_G__D_I_R_E_C_T_I_O_N__L__T_O__R.  When that
  170.       resource is _X_m_S_T_R_I_N_G__D_I_R_E_C_T_I_O_N__R__T_O__L, the descriptions for
  171.       _X_m_A_L_I_G_N_M_E_N_T__B_E_G_I_N_N_I_N_G    and _X_m_A_L_I_G_N_M_E_N_T__E_N_D are    switched.
  172.  
  173.       If the parent    is a RowColumn whose _X_m_N_i_s_A_l_i_g_n_e_d resource is
  174.       True,    _X_m_N_a_l_i_g_n_m_e_n_t is    forced to the same value as the
  175.       RowColumn's _X_m_N_e_n_t_r_y_A_l_i_g_n_m_e_n_t    if the RowColumn's
  176.       _X_m_N_r_o_w_C_o_l_u_m_n_T_y_p_e is _X_m_W_O_R_K__A_R_E_A or if    the widget is a
  177.       subclass of XmLabel.    Otherwise, the default is
  178.       _X_m_A_L_I_G_N_M_E_N_T__C_E_N_T_E_R.
  179.  
  180.       _X_m_N_f_o_n_t_L_i_s_t
  181.            Specifies the font of the text used in the widget.  If
  182.            this value is NULL at initialization, the font  list is
  183.            initialized by looking up the parent hierarchy of the
  184.            widget for an ancestor that is a    subclass of the
  185.            XmBulletinBoard,    VendorShell, or    XmMenuShell widget
  186.            class.  If such    an ancestor is found, the font list is
  187.            initialized to the _X_m_N_b_u_t_t_o_n_F_o_n_t_L_i_s_t  (for button
  188.            subclasses) or _X_m_N_l_a_b_e_l_F_o_n_t_L_i_s_t of the ancestor widget.
  189.            If no such ancestor is found, the default is
  190.            implementation dependent.  Refer    to _X_m_F_o_n_t_L_i_s_t(_3_X) for
  191.            more information    on the creation    and structure of a
  192.  
  193.  
  194.  
  195.      Page 3                        (printed 11/11/03)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))
  203.  
  204.  
  205.  
  206.            font list.
  207.  
  208.       _X_m_N_l_a_b_e_l_I_n_s_e_n_s_i_t_i_v_e_P_i_x_m_a_p
  209.            Specifies a pixmap used as the button face if
  210.            _X_m_N_l_a_b_e_l_T_y_p_e is _X_m_P_I_X_M_A_P    and the    button is insensitive.
  211.            The default value, _X_m_U_N_S_P_E_C_I_F_I_E_D__P_I_X_M_A_P,    displays an
  212.            empty label.
  213.  
  214.       _X_m_N_l_a_b_e_l_P_i_x_m_a_p
  215.            Specifies the pixmap when _X_m_N_l_a_b_e_l_T_y_p_e is _X_m_P_I_X_M_A_P.
  216.            The default value, _X_m_U_N_S_P_E_C_I_F_I_E_D__P_I_X_M_A_P,    displays an
  217.            empty label.
  218.  
  219.       _X_m_N_l_a_b_e_l_S_t_r_i_n_g
  220.            Specifies the compound string when the _X_m_N_l_a_b_e_l_T_y_p_e is
  221.            _X_m_S_T_R_I_N_G.  If this value    is NULL, it is initialized by
  222.            converting the name of the widget to a compound string.
  223.            Refer to    _X_m_S_t_r_i_n_g(_3_X) for more information on the
  224.            creation    and structure of compound strings.
  225.  
  226.       _X_m_N_l_a_b_e_l_T_y_p_e
  227.            Specifies the label type.
  228.  
  229.       +o    _X_m_S_T_R_I_N_G    - displays text    using _X_m_N_l_a_b_e_l_S_t_r_i_n_g.
  230.  
  231.       +o    _X_m_P_I_X_M_A_P    - displays pixmap using    _X_m_N_l_a_b_e_l_P_i_x_m_a_p or
  232.            _X_m_N_l_a_b_e_l_I_n_s_e_n_s_i_t_i_v_e_P_i_x_m_a_p.
  233.  
  234.       _X_m_N_m_a_r_g_i_n_B_o_t_t_o_m
  235.            Specifies the amount of spacing between the bottom of
  236.            the label text and the top of the bottom    margin
  237.            specified by _X_m_N_m_a_r_g_i_n_H_e_i_g_h_t.  This may be modified by
  238.            Label's subclasses.  For    example, CascadeButton may
  239.            increase    this field to make room    for the    cascade
  240.            pixmap.
  241.  
  242.       _X_m_N_m_a_r_g_i_n_H_e_i_g_h_t
  243.            Specifies an equal amount of spacing above the margin
  244.            defined by _X_m_N_m_a_r_g_i_n_T_o_p and below the margin defined by
  245.            _X_m_N_m_a_r_g_i_n_B_o_t_t_o_m.    _X_m_N_m_a_r_g_i_n_H_e_i_g_h_t    specifies the amount
  246.            of spacing between the top edge of the margin set by
  247.            _X_m_N_m_a_r_g_i_n_T_o_p and    the bottom edge    of the top shadow, and
  248.            the amount of spacing between the bottom    edge of    the
  249.            margin specified    by _X_m_N_m_a_r_g_i_n_B_o_t_t_o_m and the top edge of
  250.            the bottom shadow.
  251.  
  252.       _X_m_N_m_a_r_g_i_n_L_e_f_t
  253.            Specifies the amount of spacing between the left    edge
  254.            of the label text and the right side of the left    margin
  255.            (specified by _X_m_N_m_a_r_g_i_n_W_i_d_t_h).  This may    be modified by
  256.            Label's subclasses.  For    example, ToggleButton may
  257.            increase    this field to make room    for the    toggle
  258.  
  259.  
  260.  
  261.      Page 4                        (printed 11/11/03)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))
  269.  
  270.  
  271.  
  272.            indicator and for spacing between the indicator and
  273.            label.  Whether this actually applies to    the left or
  274.            right side of the label may depend on the value of
  275.            _X_m_N_s_t_r_i_n_g_D_i_r_e_c_t_i_o_n.
  276.  
  277.       _X_m_N_m_a_r_g_i_n_R_i_g_h_t
  278.            Specifies the amount of spacing between the right edge
  279.            of the label text and the left side of the right    margin
  280.            (specified by _X_m_N_m_a_r_g_i_n_W_i_d_t_h).  This may    be modified by
  281.            Label's subclasses.  For    example, CascadeButton may
  282.            increase    this field to make room    for the    cascade
  283.            pixmap.    Whether    this actually applies to the left or
  284.            right side of the label may depend on the value of
  285.            _X_m_N_s_t_r_i_n_g_D_i_r_e_c_t_i_o_n.
  286.  
  287.       _X_m_N_m_a_r_g_i_n_T_o_p
  288.            Specifies the amount of spacing between the top of the
  289.            label text and the bottom of the    top margin specified
  290.            by _X_m_N_m_a_r_g_i_n_H_e_i_g_h_t.  This may be    modified by Label's
  291.            subclasses.  For    example, CascadeButton may increase
  292.            this field to make room for the cascade pixmap.
  293.  
  294.       _X_m_N_m_a_r_g_i_n_W_i_d_t_h
  295.            Specifies an equal amount of spacing to the left    of the
  296.            margin defined by _X_m_N_m_a_r_g_i_n_L_e_f_t and to the right    of the
  297.            margin defined by _X_m_N_m_a_r_g_i_n_R_i_g_h_t.  _X_m_N_m_a_r_g_i_n_W_i_d_t_h
  298.            specifies the amount of spacing between the left    edge
  299.            of the margin set by _X_m_N_m_a_r_g_i_n_L_e_f_t and the right    edge
  300.            of the left shadow, and the amount of spacing between
  301.            the right edge of the margin specified by
  302.            _X_m_N_m_a_r_g_i_n_R_i_g_h_t and the left edge    of the right shadow.
  303.  
  304.       _X_m_N_m_n_e_m_o_n_i_c
  305.            Provides    the user with an alternate means of activating
  306.            a button.  A button in a    MenuBar, a Popup MenuPane, or
  307.            a Pulldown MenuPane can have a mnemonic.
  308.  
  309.       This resource    contains a keysym as listed in the X11 keysym
  310.       table.  The first character in the label string that exactly
  311.       matches the mnemonic in the character    set specified in
  312.       _X_m_N_m_n_e_m_o_n_i_c_C_h_a_r_S_e_t is    underlined when    the button is
  313.       displayed.
  314.  
  315.       When a mnemonic has been specified, the user activates the
  316.       button by pressing the mnemonic key while the    button is
  317.       visible.  If the button is a CascadeButton in    a MenuBar and
  318.       the MenuBar does not have the    focus, the user    must use the
  319.       _M_A_l_t modifier    while pressing the mnemonic.  The user can
  320.       activate the button by pressing either the shifted or    the
  321.       unshifted mnemonic key.
  322.  
  323.       _X_m_N_m_n_e_m_o_n_i_c_C_h_a_r_S_e_t
  324.  
  325.  
  326.  
  327.      Page 5                        (printed 11/11/03)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))
  335.  
  336.  
  337.  
  338.            Specifies the character set of the mnemonic for the
  339.            label.  The default is _X_m_F_O_N_T_L_I_S_T__D_E_F_A_U_L_T__T_A_G.
  340.  
  341.       _X_m_N_r_e_c_o_m_p_u_t_e_S_i_z_e
  342.            Specifies a Boolean value that indicates    whether    the
  343.            widget shrinks or expands to accommodate    its contents
  344.            (label string or    pixmap)    as a result of an _X_t_S_e_t_V_a_l_u_e_s
  345.            resource    value that would change    the size of the
  346.            widget.    If True, the widget shrinks or expands to
  347.            exactly fit the label string or pixmap.    If False, the
  348.            widget never attempts to    change size on its own.
  349.  
  350.       _X_m_N_s_t_r_i_n_g_D_i_r_e_c_t_i_o_n
  351.            Specifies the direction in which    the string is to be
  352.            drawn.  The following are the values:
  353.  
  354.       +o    _X_m_S_T_R_I_N_G__D_I_R_E_C_T_I_O_N__L__T_O__R - left    to right
  355.  
  356.       +o    _X_m_S_T_R_I_N_G__D_I_R_E_C_T_I_O_N__R__T_O__L - right to left
  357.  
  358.       The default for this resource    is determined at creation
  359.       time.     If no value is    specified for this resource and    the
  360.       widget's parent is a manager,    the value is inherited from
  361.       the parent; otherwise, it defaults to
  362.       _X_m_S_T_R_I_N_G__D_I_R_E_C_T_I_O_N__L__T_O__R.
  363.  
  364.     IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  365.       Label    inherits behavior and resources    from the following
  366.       superclasses.     For a complete    description of each resource,
  367.       refer    to the man page    for that superclass.
  368.  
  369.                      XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  370.      NNNNaaaammmmeeee             CCCCllllaaaassssssss             TTTTyyyyppppeeee        DDDDeeeeffffaaaauuuulllltttt               AAAAcccccccceeeessssssss
  371.      ________________________________________________________________________________________________
  372.      XmNbottomShadowColor    XmCBottomShadowColor    Pixel        dynamic               CSG
  373.      XmNbottomShadowPixmap   XmCBottomShadowPixmap   Pixmap        XmUNSPECIFIED_PIXMAP   CSG
  374.      XmNforeground         XmCForeground         Pixel        dynamic               CSG
  375.      XmNhelpCallback         XmCCallback         XtCallbackList    NULL               C
  376.      XmNhighlightColor         XmCHighlightColor         Pixel        dynamic               CSG
  377.      XmNhighlightOnEnter     XmCHighlightOnEnter     Boolean        False               CSG
  378.      XmNhighlightPixmap         XmCHighlightPixmap         Pixmap        dynamic               CSG
  379.      XmNhighlightThickness   XmCHighlightThickness   Dimension        0               CSG
  380.      XmNnavigationType         XmCNavigationType         XmNavigationType    XmNONE               CSG
  381.      XmNshadowThickness         XmCShadowThickness         Dimension        0               CSG
  382.      XmNtopShadowColor         XmCTopShadowColor         Pixel        dynamic               CSG
  383.      XmNtopShadowPixmap         XmCTopShadowPixmap         Pixmap        dynamic               CSG
  384.      XmNtraversalOn         XmCTraversalOn         Boolean        False               CSG
  385.      XmNunitType         XmCUnitType         unsigned char    dynamic               CSG
  386.      XmNuserData         XmCUserData         XtPointer        NULL               CSG
  387.  
  388.  
  389.                            CCCCoooorrrreeee    RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  390.  
  391.  
  392.  
  393.      Page 6                        (printed 11/11/03)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))
  401.  
  402.  
  403.  
  404.      NNNNaaaammmmeeee                 CCCCllllaaaassssssss                 TTTTyyyyppppeeee          DDDDeeeeffffaaaauuuulllltttt             AAAAcccccccceeeessssssss
  405.      ______________________________________________________________________________________________________________
  406.      XmNaccelerators             XmCAccelerators             XtAccelerators   dynamic             CSG
  407.      XmNancestorSensitive         XmCSensitive             Boolean          dynamic             G
  408.      XmNbackground             XmCBackground             Pixel          dynamic             CSG
  409.      XmNbackgroundPixmap         XmCPixmap                 Pixmap          XmUNSPECIFIED_PIXMAP   CSG
  410.      XmNborderColor             XmCBorderColor             Pixel          XtDefaultForeground    CSG
  411.      XmNborderPixmap             XmCPixmap                 Pixmap          XmUNSPECIFIED_PIXMAP   CSG
  412.      XmNborderWidth             XmCBorderWidth             Dimension          0                 CSG
  413.      XmNcolormap             XmCColormap             Colormap          dynamic             CG
  414.      XmNdepth                 XmCDepth                 int          dynamic             CG
  415.      XmNdestroyCallback             XmCCallback             XtCallbackList   NULL             C
  416.      XmNheight                 XmCHeight                 Dimension          dynamic             CSG
  417.      XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True             C
  418.      XmNmappedWhenManaged         XmCMappedWhenManaged         Boolean          True             CSG
  419.      XmNscreen                 XmCScreen                 Screen *          dynamic             CG
  420.      XmNsensitive             XmCSensitive             Boolean          True             CSG
  421.      XmNtranslations             XmCTranslations             XtTranslations   dynamic             CSG
  422.      XmNwidth                 XmCWidth                 Dimension          dynamic             CSG
  423.      XmNx                 XmCPosition             Position          0                 CSG
  424.      XmNy                 XmCPosition             Position          0                 CSG
  425.  
  426.  
  427.     TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  428.       XmLabel includes translations    from Primitive.     The XmLabel
  429.       translations are listed below.  These    translations may not
  430.       directly correspond to a translation table.
  431.       BDrag    Press:     ProcessDrag()
  432.  
  433.       KHelp:     Help()
  434.       The translations used    by subclasses of XmLabel for menu
  435.       traversal are    listed below.  These translations may not
  436.       directly correspond to a translation table.
  437.       KLeft:     MenuTraverseLeft()
  438.       KRight:     MenuTraverseRight()
  439.       KUp:         MenuTraverseUp()
  440.       KDown:     MenuTraverseDown()
  441.       MAny KCancel:     MenuEscape()
  442.  
  443.     AAAAccccttttiiiioooonnnn RRRRoooouuuuttttiiiinnnneeeessss
  444.       The XmLabel action routines are described below:
  445.  
  446.       _H_e_l_p():
  447.            In a Popup or Pulldown MenuPane,    unposts    all menus in
  448.            the menu    hierarchy and, when the    shell's    keyboard focus
  449.            policy is _X_m_E_X_P_L_I_C_I_T, restores keyboard focus to    the
  450.            widget that had the focus before    the menu system    was
  451.            entered.     Calls the callbacks for _X_m_N_h_e_l_p_C_a_l_l_b_a_c_k if
  452.            any exist.  If there are    no help    callbacks for this
  453.            widget, this action calls the help callbacks for    the
  454.            nearest ancestor    that has them.
  455.  
  456.  
  457.  
  458.  
  459.      Page 7                        (printed 11/11/03)
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.      XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))
  467.  
  468.  
  469.  
  470.       _M_e_n_u_E_s_c_a_p_e():
  471.            In a MenuBar, disarms the CascadeButton and the menu
  472.            and, when the shell's keyboard focus policy is
  473.            _X_m_E_X_P_L_I_C_I_T, restores keyboard focus to the widget that
  474.            had the focus before the    menu was entered.
  475.  
  476.            In a toplevel Pulldown MenuPane from a MenuBar, unposts
  477.            the menu, disarms the MenuBar CascadeButton and the
  478.            MenuBar,    and, when the shell's keyboard focus policy is
  479.            _X_m_E_X_P_L_I_C_I_T, restores keyboard focus to the widget that
  480.            had the focus before the    MenuBar    was entered.  In other
  481.            Pulldown    MenuPanes, unposts the menu and    moves the
  482.            focus to    its CascadeButton.
  483.  
  484.            In a Popup MenuPane, unposts the    menu and, when the
  485.            shell's keyboard    focus policy is    _X_m_E_X_P_L_I_C_I_T, restores
  486.            keyboard    focus to the widget from which the menu    was
  487.            posted.
  488.  
  489.       _M_e_n_u_T_r_a_v_e_r_s_e_D_o_w_n():
  490.            If the current menu item    has a submenu and is in    a
  491.            MenuBar,    then this action posts the submenu, disarms
  492.            the current menu    item, and arms the submenu's first
  493.            traversable menu    item.
  494.  
  495.            If the current menu item    is in a    MenuPane, then this
  496.            action disarms the current menu item and    arms the item
  497.            below it.  This action wraps within the MenuPane.  When
  498.            the current menu    item is    at the MenuPane's bottom edge,
  499.            then this action    wraps to the topmost menu item in the
  500.            column to the right, if one exists.  When the current
  501.            menu item is at the bottom, rightmost corner of the
  502.            MenuPane, then this action wraps    to the tear-off
  503.            control,    if present, or to the top, leftmost menu item.
  504.  
  505.       _M_e_n_u_T_r_a_v_e_r_s_e_L_e_f_t():
  506.            When the    current    menu item is in    a MenuBar, then    this
  507.            action disarms the current item and arms    the MenuBar
  508.            item to the left.  This action wraps within the
  509.            MenuBar.
  510.  
  511.            In MenuPanes, if    the current menu item is not at    the
  512.            left edge of a MenuPane,    this action disarms the
  513.            current item and    arms the item to its left.  If the
  514.            current menu item is at the left    edge of    a submenu
  515.            attached    to a MenuBar item, then    this action unposts
  516.            the submenu and traverses to the    MenuBar    item to    the
  517.            left, wrapping if necessary.  If    that MenuBar item has
  518.            a submenu, it posts the submenu and arms    the first
  519.            traversable item    in the submenu.     If the    current    menu
  520.            item is at the left edge    of a submenu not directly
  521.            attached    to a MenuBar item, then    this action unposts
  522.  
  523.  
  524.  
  525.      Page 8                        (printed 11/11/03)
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.      XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))
  533.  
  534.  
  535.  
  536.            the current submenu only.
  537.  
  538.            In Popup    or Torn-off MenuPanes, when the    current    menu
  539.            item is at the left edge, this  action wraps within the
  540.            MenuPane.  If the current menu item is at the left edge
  541.            of the MenuPane and not in the top row, this action
  542.            wraps to    the rightmost menu item    in the row above.  If
  543.            the current menu    item is    in the upper, leftmost corner,
  544.            this action wraps to the    tear-off control, if present,
  545.            or else it wraps    to the bottom, rightmost menu item in
  546.            the MenuPane.
  547.  
  548.       _M_e_n_u_T_r_a_v_e_r_s_e_R_i_g_h_t():
  549.            If the current menu item    is in a    MenuBar, then this
  550.            action disarms the current item and arms    the MenuBar
  551.            item to the right.  This    action wraps within the
  552.            MenuBar.
  553.  
  554.            In MenuPanes, if    the current menu item is a
  555.            CascadeButton, then this    action posts its associated
  556.            submenu.     If the    current    menu item is not a
  557.            CascadeButton and is not    at the right edge of a
  558.            MenuPane, this action disarms the current item and arms
  559.            the item    to its right, wrapping if necessary. If    the
  560.            current menu item is not    a CascadeButton    and is at the
  561.            right edge of a submenu that is a descendent of a
  562.            MenuBar,    then this action unposts all submenus and
  563.            traverses to the    MenuBar    item to    the right.  If that
  564.            MenuBar item has    a submenu, it posts the    submenu    and
  565.            arms the    submenu's first    traversable item.
  566.  
  567.            In Popup    or Torn-off menus, if the current menu item is
  568.            not a CascadeButton and is at the right edge of a row
  569.            (except the bottom row),    this action wraps to the
  570.            leftmost    menu item in the row below.  If    the current
  571.            menu item is not    a CascadeButton    and is in the bottom,
  572.            rightmost corner    of a Popup or Pulldown MenuPane, this
  573.            action wraps to the tear-off control, if    present, or
  574.            else it wraps to    the top, leftmost menu item of the
  575.            MenuPane.
  576.  
  577.       _M_e_n_u_T_r_a_v_e_r_s_e_U_p():
  578.            When the    current    menu item is in    a MenuPane, then this
  579.            action disarms the current menu item and    arms the item
  580.            above it.  This action wraps within the MenuPane.  When
  581.            the current menu    item is    at the MenuPane's top edge,
  582.            then this action    wraps to the bottommost    menu item in
  583.            the column to the left, if one exists.  When the
  584.            current menu item is at the top,    leftmost corner    of the
  585.            MenuPane, then this action wraps    to the tear-off
  586.            control,    if present, or to the bottom, rightmost    menu
  587.            item.
  588.  
  589.  
  590.  
  591.      Page 9                        (printed 11/11/03)
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.      XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX))))
  599.  
  600.  
  601.  
  602.       _P_r_o_c_e_s_s_D_r_a_g():
  603.            Drags the contents of a Label, identified by pressing
  604.            _B_D_r_a_g.  This action creates a DragContext object    whose
  605.            _X_m_N_e_x_p_o_r_t_T_a_r_g_e_t_s    resource is set    to "COMPOUND_TEXT" for
  606.            a label type of _X_m_S_T_R_I_N_G; otherwise, "PIXMAP" if    the
  607.            label type is _X_m_P_I_X_M_A_P.    This action is undefined for
  608.            Labels used in a    menu system.
  609.  
  610.            This action is disabled if the XmDisplay's
  611.            _e_n_a_b_l_e_U_n_s_e_l_e_c_t_a_b_l_e_D_r_a_g resource is True.
  612.  
  613.     VVVViiiirrrrttttuuuuaaaallll    BBBBiiiinnnnddddiiiinnnnggggssss
  614.       The bindings for virtual keys    are vendor specific.  For
  615.       information about bindings for virtual buttons and keys, see
  616.       _V_i_r_t_u_a_l_B_i_n_d_i_n_g_s(_3_X).
  617.  
  618.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  619.       _C_o_r_e(_3_X), _X_m_C_r_e_a_t_e_L_a_b_e_l(_3_X), _X_m_D_i_s_p_l_a_y(_3_X),
  620.       _X_m_F_o_n_t_L_i_s_t_A_p_p_e_n_d_E_n_t_r_y(_3_X), _X_m_S_t_r_i_n_g_C_r_e_a_t_e(_3_X),
  621.       _X_m_S_t_r_i_n_g_C_r_e_a_t_e_L_t_o_R(_3_X), and _X_m_P_r_i_m_i_t_i_v_e(_3_X).
  622.  
  623.  
  624.  
  625.  
  626.  
  627.  
  628.  
  629.  
  630.  
  631.  
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.      Page 10                        (printed 11/11/03)
  658.  
  659.  
  660.  
  661.